# -*- coding: utf-8 -*-
# בש״ד
#
# Miramar CMS for Django - Part of the Cuba Libre Project
# Copyright (C) 2009, Joshua "jag" Ginsberg <jag@flowtheory.net>
# 
# Por mi amor, que inspira a mi cada respiración y que echa de Cuba
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from taino.api import Interface

class IMiramarMarkupEngine(Interface):
    
    def get_markup_type():
        """Return the MarkItUp markup type -- e.g. markdown, html, textile"""
    
    def render_as_html(markup):
        """Return HTML from the given markup text."""
    
    def boiler_plate_page(title):
        """Return markup for a new empty page."""
    
class IMiramarMarkupNamespace(Interface):
    """A namespace system to allow other content types to plug into the CMS 
    markup"""
    
    def get_namespace_identifier():
        """Returns the identifier in markup for this namespace"""
    
    def get_manager_obj():
        '''Returns the object manager for the content type referred to by this
        namespace'''
    
    def get_detail_url_name():
        '''Returns the detail url for an object of the content type referred
        to by this namespace'''
        
    def get_create_url_name():
        '''Returns the create url for an object of the content type referred
        to by this namespace'''

